home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / bbs_util / ftg110.zip / FILES2TG.DOC < prev    next >
Text File  |  1996-06-07  |  38KB  |  814 lines

  1.     |
  2.     |  FILES2TG 1.10 documentation
  3.     |
  4.     |  Full Featured files.bb? to Telegard 3.0 file-area converter.
  5.     |
  6.     |  Copyright 1995,1996 by Dave Turner & THN Programming
  7.     |  All rights reserved.
  8.     |  
  9.  
  10.                         _____________________________
  11.                         //   PROGRAMME  SYNOPSIS   //
  12.  
  13.     FILES2TG will read the DOS file FILES.BBS (or FILES.BB1 .. FILES.BB9)
  14.     in the download directory of all or a specified file area, and import
  15.     the files specified in the FILES.BB? into the Telegard 3 file record.
  16.  
  17.     This utility is useful for persons using  file  distribution systems.
  18.     This product is  named  after Martin Pollard's FILES2TG.EXE which was
  19.     written for Telegard 2.7, and distributed as part of the Telegard 2.7
  20.     utilities package.
  21.  
  22.                         _____________________________
  23.                         //  SHAREWARE  LEGALITIES  //
  24.  
  25.     This program has undergone many stages of testing by  many people  to
  26.     make  it as reliable  as possible.  This program works  for  me and I
  27.     sincerely hope it works for you as well!
  28.  
  29.     No warranties or  responsibilities  accompany  this program. By using
  30.     this  program,  you  agree that  Dave  Turner,  THN  Programming, and
  31.     members of the beta testing team, sites, and affiliate centres are not
  32.     liable for any destruction recurring from this programs use or misuse.
  33.     Further, you  also  agree  not  to  pursue  any legal actions or hold
  34.     accountable those mentioned above due to any damages .  IF YOU DO NOT
  35.     AGREE, PLEASE DO NOT USE THIS PROGRAM.
  36.  
  37.     FILES2TG is NOT public domain software.  You are granted the right to
  38.     make as many copies  of  the  standard  release  version as  you wish
  39.     provided all files in the distribution archive remain intact, without
  40.     any changes or modifications.  Hex edits, reverse engineering and any
  41.     other form of modification to FILES2TG (or any respective  component)
  42.     is considered copyright infringement and legal action may be pursued.
  43.  
  44.     This software was produced for  Telegard 3.0/Gamma-4, and as such  is 
  45.     still in the stages of development. Version 1.10 is a total rewrite
  46.     of older versions.  New wide-beta releases of FILES2TG v1.10 will be
  47.     made as bugs are fixed and/or features are implemented.
  48.  
  49.                         _____________________________
  50.                         // PROGRAMME  REQUIREMENTS //
  51.  
  52.      FILES2TG.EXE is programmed to require the following:
  53.  
  54.        HARDWARE:
  55.           ■    AT-Compatible Bios,
  56.           ■    80+ Kilobytes of RAM.  It is highly recommended that
  57.                FILES2TG.EXE never is run with less than 172 Kilobytes free
  58.                conventional RAM.  More free memory makes file moving much
  59.                quicker.
  60.           ■    A colour monitor capable of 80x25, 16/32c.
  61.           ■    A hard drive (obviously)
  62.  
  63.        SOFTWARE:
  64.           ■    MS-DOS (or 100% compatible) Vsn 3.30 or better.
  65.           ■    SHARE.EXE loaded {*}
  66.           ■    Telegard 3.0/Gamma Bulletin Board operating System.
  67.           ■    Files processor capable of producing a standard ASCII
  68.                FILES.BBS control file (ie: Allfix[R]).
  69.  
  70.                         _____________________________
  71.                         // PROGRAMME  INSTALLATION //
  72.  
  73.     Installation  of  FILES2TG is quite  simple since there is  only  ONE
  74.     executable file (FILES2TG.EXE),  and  vital  runtime  information  is
  75.     gathered from the command-line and Telegard's data files.
  76.  
  77.     If you use the  "TELEGARD"  environmental variable, FILES2TG will use 
  78.     the directory specified in that variable. If  you  *do not*  use this
  79.     variable FILES2TG will look for CONFIG.TG in: (1) the DOS search path
  80.     (2) current DOS directory. 
  81.  
  82.     FILES2TG *REQUIRES* a working directory for disk swapping (if needed),
  83.     file archive extractions and other miscellaneous tasks. FILES2TG will
  84.     use the pathspec specified by  the DOS "TEMP" environmental variable. 
  85.     If this variable does not exist, the  directory FILES2TG is  executed
  86.     form will be used.
  87.  
  88.     FILES2TG will also search for the "FTGDUPE"  environmental  variable.
  89.     If found, the pathspec in "FTGDUPE" will be used for moving duplicate
  90.     files.  The FTGDUPE environmental  variable is ignored if the /M"???"
  91.     command-line argument is used.
  92.  
  93.     Keeping the above in mind, place the FILES2TG.EXE in a directory where
  94.     it can access CONFIG.TG.  Most people place FILES2TG.EXE in  the main
  95.     Telegard directory (ie: C:\TG\).
  96.  
  97.                         _____________________________
  98.                         //   RUN-TIME   DEFAULTS   //
  99.  
  100.     Although FILES2TG.EXE can run without the  use  of  any  command-line
  101.     arguments, it may be desirable to use command-line arguments to enable
  102.     some internal FILES2TG features.
  103.  
  104.     By default (no command line parameters  specified), FILES2TG will use
  105.     the following options/functions:
  106.  
  107.         *    Uses swapping to disk when shelling,
  108.         *    Scan/Import into all non-cdrom Telegard file areas,
  109.         *    Import files as "available, and hatch",
  110.         *    Import missing files as offline entries,
  111.         *    Move duplicate files,
  112.         *    Use "FTG v1.10.wb?" as the file uploader string,
  113.         *    Remove any FILES.BB? found after processing,
  114.         *    Attempt to import a FILE_ID.DIZ/DESC.SDI from the archive; if
  115.              not available, the FILES.BB? description is used,
  116.      
  117.     You  can  change these  run  time  values by using any combination of
  118.     command line arguments (explained in the next section).  
  119.  
  120.                         _____________________________
  121.                         // COMMAND LINE PARAMETERS //
  122.  
  123.     FILES2TG.EXE uses a command-line to pass arguments to  define runtime
  124.     settings,  such  as duplicate file path, character stripping etc. The
  125.     following is  a  list  and  description  of  EACH  valid command-line
  126.     argument (parameter).
  127.  
  128.           -A"???"  READ FROM FILES.BB? IN ALTERNATE PATHSPEC.
  129.                By default, FILES2TG will  read  from  any  FILES.BBS (or
  130.                FILES.BB1..FILES.BB9) located in the download path (file
  131.                storage pathspec) for each area.
  132.  
  133.                Certain cd-rom distributors do not use the accepted file
  134.                (FILES.BB?) standard,  thus resulting  in  compatibility
  135.                problems, since it  is  impossible  to  edit a  file  on
  136.                read-only media.  The solution is to copy the  offending
  137.                files.bb? into  a  temporary  hard  drive directory, and
  138.                edit it so that it becomes compatible.
  139.  
  140.                Use this parameter if you wish to read from a  files.bb?
  141.                located outside the area's file storage pathspec.
  142.  
  143.                Place  the complete (and  valid) drive:directory\filespec
  144.                between the quotation marks. FILES2TG.EXE will attempt to
  145.                resolve the pathspec  you supply.  If   the  pathspec  is
  146.                invalid, FILES2TG will terminate with a DOS ERRORLEVEL of
  147.                2.  Do not include a trailing forward-slash.
  148.  
  149.                This parameter only works when specified with the /B"???"
  150.                command-line argument.  In  other  words, this  option is
  151.                *not* valid on global tosses.
  152.  
  153.                Example(s):  FILES2TG.EXE /B"C:\TEMP!"
  154.                               (* the above will cause FILES2TG to look
  155.                                for a files.bb? in C:\TEMP! *)
  156.  
  157.  
  158.           -B"???"  SCAN/IMPORT INTO FILE BASE ???.
  159.                By default, FILES2TG will scan and import all file  areas
  160.                except those marked as  cd-rom media (unless /C is used).
  161.                
  162.                If you want to toss files in a particular  file area, use
  163.                this parameter.
  164.  
  165.                Place the complete (and valid) file area TAG name between
  166.                the quotation marks. FILES2TG will attempt to resolve the
  167.                tag name. If the area tag name is invalid,  FILES2TG will
  168.                terminate with a DOS ERRORLEVEL of 2.
  169.  
  170.                Example(s):  FILES2TG.EXE /B"FIDOSDN"
  171.                               (* the above will toss files in the area
  172.                                with the tag name FIDOSDN *)
  173.  
  174.  
  175.           -C       DO NOT SKIP (USE) CD-ROM FILE BASES.
  176.                By default, FILES2TG will not toss any FILES.BB? found in
  177.                areas designated as "cdrom media".  
  178.  
  179.                Use this argument if you wish to import FILES.BB? found on
  180.                cd-rom media.  See section "IMPORTING CD AREAS"
  181.  
  182.                Example(s):  FILES2TG.EXE /C
  183.  
  184.  
  185.           -D       PRESERVE (KEEP) ANY FILES.BB? FOUND AFTER USE.
  186.                By default, FILES2TG will purge any  FILES.BB?  files  it
  187.                encounters during tossing, except those found in cd-media
  188.                designated bases.
  189.  
  190.                If you wish the FILES.BB? file not to be removed from its
  191.                resting directory, use this parameter.  
  192.  
  193.                Example(s):  FILES2TG.EXE /D
  194.  
  195.  
  196.           -E"???"  CHANGE MEMORY SWAP LOCATION TO ??.  0=Disk 1=EMS 2=XMS
  197.                Whenever FILES2TG has to extract a FILE_ID.DIZ / DESC.SDI
  198.                from an archive, it will swap part of conventional memory
  199.                to another location.  This  gives  the  archive  software
  200.                more RAM to operate with.
  201.  
  202.                By default, FILES2TG will use the DISK swap shell.  Disk
  203.                swapping is somewhat slower than EMS or XMS swapping, but
  204.                under certain environments,  it  may  be the only option.
  205.                When  you  want  FILES2TG to change swap type on-the-fly,
  206.                use the -E"???" parameter
  207.  
  208.                If  you  want  FILES2TG  to preform it's memory swap to a
  209.                location other than the one defined in Telegard, use this
  210.                parameter.
  211.  
  212.                Example(s):  FILES2TG.EXE /E"1"
  213.                               (* the above will swap to EMS *)
  214.                             FILES2TG.EXE /E"2"
  215.                               (* the above will swap to XMS *)
  216.  
  217.                Memory errors can occur  if  EMS  frame  C800 is used for
  218.                BIOS shadowing,  or when  running  under  a multi-tasking
  219.                environment  where not enough memory is allocated to  the
  220.                task.
  221.  
  222.                Also, when running FILES2TG while  shelled  from Telegard
  223.                or through Doorway, (or other shells that  swaps to EMS),
  224.                it may be necessary to use XMS or DISK swapping.
  225.                
  226.  
  227.           -F       DO NOT USE THE FILE'S FILE_ID.DIZ/DESC.SDI.
  228.                By default, FILES2TG will attempt to extract  FILE_ID.DIZ
  229.                or  DESC.SDI from any archive file TELEGARD can identify.
  230.                Descriptions  from  the  FILE_ID.DIZ or DESC.SDI (if they
  231.                exist) are used  in  place of standard FILES.BB? extended
  232.                descriptions.
  233.  
  234.                If you do not want FILES2TG to import the FILE_ID.DIZ or
  235.                DESC.SDI from a file archive, use this parameter.
  236.  
  237.                This parameter is useful for people  who  use  TIC  file
  238.                processors which use the FILE_ID.DIZ  or  DESC.SDI  from
  239.                archives as extended descriptions in the FILES.BB?
  240.                
  241.                The actual process  of  swapping  out  and  extracting a
  242.                FILE_ID.DIZ or DESC.SDI  from  archives  can take a  few
  243.                seconds.
  244.  
  245.                Example(s):  FILES2TG.EXE /F
  246.  
  247.           -H       DO NOT POST (SKIP) SYSTEM OPERATOR NOTIFICATION.
  248.                By default,  FILES2TG  will  post  a  brief bullet-style
  249.                message to the  system operator (the first record in the
  250.                user database) indicating the time and date FILES2TG was
  251.                last executed.  This message is  posted in  the Telegard
  252.                SHORTMSG.DAT file.  The message will be displayed during
  253.                a normal login or whenever the menucmd "LS" is issued.
  254.  
  255.                If you do not want FILES2TG to post  a  short-message to
  256.                the system operator, use this command line argument.
  257.  
  258.                Example(s):  FILES2TG.EXE /H
  259.  
  260.  
  261.           -I       IGNORE (DO NOT USE) EXTENDED DESCRIPTIONS.
  262.                By default, FILES2TG will take extended descriptions from
  263.                the FILES.BB? and use them in Telegard. 
  264.  
  265.                Use this argument if you wish to exclude extended (verbose)
  266.                descriptions.
  267.  
  268.                Example(s):  FILES2TG.EXE /I
  269.  
  270.  
  271.           -K       CLEAN (NORMALIZE) DESCRIPTION CHARACTER CASINGS.
  272.                If you want FILES2TG to attempt casing normalization, use
  273.                this parameter.   Casing  normalization  makes  the first
  274.                character of each word an upper case letter, while making
  275.                any other characters lower case letters. 
  276.  
  277.                Numerical/high-ascii characters are ignored.
  278.  
  279.                Example(s):  FILES2TG.EXE /K
  280.  
  281.  
  282.           -L  DO NOT UPLOAD MISSING FILES AS OFFLINE ENTRIES.
  283.                By default, FILES2TG will  consider files  which exist in
  284.                the FILES.BBS but not in DOS as offline,  thus  uploading
  285.                them as "offline entries".  This is the  opposite of  how
  286.                previous versions did things.
  287.                
  288.                
  289.                If you want FILES2TG *not* to import files listed  in the
  290.                the FILES.BB? but not found in DOS, use this parameter.
  291.  
  292.                Example(s):  FILES2TG.EXE /L
  293.  
  294.  
  295.           -M"???"  CHANGE THE DIRECTORY FOR DUPE FILE MOVING TO ???.
  296.                By default, FILES2TG will attempt to move duplicate files
  297.                encountered unless they are on a cd-rom.  You  have *two*
  298.                options for specifying a directory (pathspec) for  moving
  299.                duplicate files into.
  300.  
  301.                The first option was  described earlier.   The  "FTGDUPE"
  302.                DOS environmental variable can contain a pathspec for
  303.                moving duplicate files.
  304.  
  305.                The second option involves using this argument to specify
  306.                a pathspec for moving files.
  307.  
  308.                If the "FTGDUPE" and /M"???" are  not  provided, FILES2TG
  309.                will use the pathspec it was executed from.   The /M"???"
  310.                will overide the "FTGDUPE" pathspec value.
  311.  
  312.                Place the complete (and  valid) drive:directory\  between
  313.                the quotation marks. FILES2TG will attempt to resolve the
  314.                pathspec you supply. If the pathspec is invalid, FILES2TG
  315.                will terminate with a DOS ERRORLEVEL of 2.
  316.  
  317.                Example(s):  FILES2TG.EXE /M"F:\DLS\FTGDUPES\"
  318.                             FILES2TG.EXE /M"C:\BBS\DLOADS\FAILED"
  319.  
  320.  
  321.           -O  UPDATE (REFRESH) ALL EXISTING FILES.
  322.                By default, FILES2TG will simply  skip  over  any  files
  323.                that already exist in the current area being scanned. 
  324.  
  325.                Since file  distribution  networks often re-hatch update
  326.                files using the  same filename (ie: FILEBONE.NA), it may
  327.                be desirable  to update the file's record to reflect the
  328.                new file size, points et al.
  329.  
  330.                If you want to update existing files in the CURRENT area,
  331.                use this parameter.
  332.  
  333.                Example(s):  FILES2TG.EXE /O
  334.  
  335.  
  336.           -P"???"  CHANGE DEFAULT FILE RECORD FLAGS TO ??.
  337.                By default, FILES2TG  will  import  files  as "available"
  338.                and "hatch".  These are known as "file record flags".  If
  339.                you wish to import files as "validated", "free download",
  340.                or "not download time check", use this parameter.
  341.  
  342.                  SYMBOL       FLAG
  343.                  F or f       "freedl" flag
  344.                  N or n       "notimecheck" flag
  345.                  V or v       "validated" flag.
  346.  
  347.                These symbols are used alone or  in  combination  to tell
  348.                FILES2TG what you want in  the  file  listing.  Place the
  349.                symbols (listed above)  between quotation marks; seperate
  350.                them with a colon -OR- semi-colon.
  351.  
  352.                Example(s):  FILES2TG.EXE /P"F:V"
  353.                           (the above will upload files with the "freedl"
  354.                           and "validated" flags.)
  355.  
  356.  
  357.           -R        FILTER COLOUR OR MCI CODES FROM DESCRIPTIONS.
  358.                If you want to strip pipe/tilde colour codes found in the
  359.                file descriptions (if applicable), use this parameter.
  360.  
  361.                This option will also remove ~xx Telegard MCI coding.
  362.  
  363.                Example(s):  FILES2TG.EXE /R
  364.  
  365.  
  366.           -S       FILTER 8-BIT ASCII CHARACTERS FROM DESCRIPTIONS.
  367.                If you want to remove any characters classified as "high-
  368.                ascii", use this parameter.
  369.  
  370.                This function will strip characters whose ordinate values 
  371.                are from 001 to 031  and  127 to 255.  Each non-printable
  372.                character striped is replaced with a space.  For example:
  373.                replacing the non-printable characters in "┌───[FTG]───┐"
  374.                would result in: "    [FTG]    ".
  375.  
  376.                Example(s):  FILES2TG.EXE /S
  377.  
  378.  
  379.           -T  USE IMPORT ACTIVITY TEXTUAL LOGGING.
  380.                FILES2TG offers both textual activity logging and textual
  381.                duplicate  file  logging.  Textual activity  logging is a
  382.                reasonably detailed log  what FILES2TG does when tossing,
  383.                while  textual  duplicate  file  logging provides a semi-
  384.                detailed information  on duplicate file encountered while
  385.                tossing.
  386.  
  387.                Both these logs are stored in the Telegard logs pathspec.
  388.                Logs  are  limited  only  by  available hard drive space. 
  389.                Using the  textual logging  system will slow down average
  390.                tossing speed by a couple of seconds.
  391.  
  392.                If you want FILES2TG to create and maintain these two log
  393.                files, use this parameter.
  394.  
  395.                Example(s):  FILES2TG.EXE /T
  396.  
  397.  
  398.           -U"???"  CHANGE UPLOADER (UPLOADED BY) TO ???.
  399.                Telegard file areas have the ability to store the name or
  400.                alias of the user who uploaded a particular file. This is
  401.                known as the "uploader name" or simply "uploader".
  402.  
  403.                By default,  FILES2TG  will  place "FTG.EXE v1.10" as the
  404.                uploader when it imports files into Telegard. If you want
  405.                to specify a different uploader string, use this parameter.
  406.                
  407.                Place  the  complete (and valid)  uploader string of your
  408.                choice between the quotation marks.
  409.  
  410.                Remember, spaces must be  represented  by  the underscore 
  411.                "_" character.  Uploader name strings are  limited to  35
  412.                characters 
  413.  
  414.                Example(s):  FILES2TG.EXE /U"Software_Distribution_System"
  415.                             FILES2TG.EXE -U"SysOp"
  416.               
  417.  
  418.           -V  PURGE ANY DUPLICATE FILES ENCOUNTERED.
  419.                By default, all duplicate files encountered are moved from
  420.                the file area's directory into a  duplicate file pathspec.
  421.                The duplicate file pathspec is defined using the "FTGDUPE"
  422.                DOS environmental variable,  or  the /M"???"  command-line
  423.                argument.
  424.  
  425.                Under high-traffic and/or low  disk  space  conditions, it
  426.                may be desirable to purge any duplicate  files rather than
  427.                store them. If you wish to PURGE any duplicate files found
  428.                during normal tossing of NON-CDROM bases, use this command-
  429.                line argument.
  430.  
  431.                Example(s):  FILES2TG.EXE /V
  432.  
  433.  
  434.           -W  IGNORE (DO NOT CHECK) CD-ROM AREA/DISK LABELS.
  435.                By default, FILES2TG will check volume labels specified for
  436.                the file area against those on the actual cdrom.  This is a
  437.                method of checking to see that cd-rom areas do not get
  438.                tossed together.
  439.  
  440.                If you have reason NOT to preform volume/disk label checks,
  441.                use this parameter.
  442.  
  443.                Example(s):  FILES2TG.EXE /W
  444.  
  445.  
  446.           -X       ENABLE FILE DESCRIPTION LONG LINE WRAPPING.
  447.                     { not fully implemented function }
  448.  
  449.                By default, FILES2TG will *not*  compensate  for  FILES.BB?
  450.                descriptions longer than 45 characters. Simply put, it will
  451.                ignore all characters after the 45th one. This also applies
  452.                to any FILE_ID.DIZ/DESC.SDI files.
  453.  
  454.                There are times when it  may  be  desirable  to "wrap" long
  455.                descriptions.  Use  this command-line  argument if you want
  456.                any long descriptions wrapped (as needed).
  457.  
  458.                I am personally not in favor of this feature,  therefore I
  459.                will not be going  out  of  my  way  to  finish it's final
  460.                implementation.
  461.  
  462.                Example(s):  FILES2TG.EXE /X
  463.  
  464.                LIMITATIONS:
  465.                 - Wrapping only applies to FILES.BB? descriptions,
  466.                 - Line wrapping  only  works on descriptions shorter than
  467.                   90 characters,
  468.                 - There is no compensation for the "chainsaw" or "step"
  469.                   effect,
  470.                 - varied results appear when using MCI desc. codes,
  471.  
  472.  
  473.           -Z       CHANNEL SCREEN WRITES THROUGH BIOS.
  474.                FILES2TG normally uses direct screen writes.  Under certain  
  475.                multitasker software such as DesqView this can cause screen
  476.                bleeding from one  window  to  another.  Most  multitasking
  477.                software  offer text/graphic  virtualization,  however,  if
  478.                desired (as an alternative), you can instruct  FILES2TG  to
  479.                make all it's screen writes through  your BIOS.  This  will
  480.                solve most screen-bleeding.
  481.    
  482.                Example(s):  FILES2TG.EXE /Z
  483.  
  484.                Note, this option *will*  slow the screen write rate  quite
  485.                dramatically.  This parameter does not appear on  the valid
  486.                parameter list when you run FILES2TG.EXE /?
  487.           
  488.           -?  ACQUIRE PARAMETER HELP, EXIT
  489.                Like most command-line driven DOS programmes,  FILES2TG has
  490.                an online argument listing with brief explanations.  If you
  491.                require a reminder about parameters, use this  command-line
  492.                argument.
  493.  
  494.                Example(s):  FILES2TG.EXE /?
  495.  
  496.                FILES2TG exists with a DOS errorlevel of 1  after executing
  497.                this command.
  498.  
  499.                If this  command appears in combination with other command-
  500.                line parameters, it  will  take  priority.  This  means you
  501.                cannot specify this parameter amoung other parameters.
  502.  
  503.      FILES2TG will accept hyphenated parameters and oblique parameters.  For
  504.      example, /C is the same as -C.  Parameters can appear in any order, and
  505.      with exception to uploader name, casing is not important.  If you  pass
  506.      an illegal parameter, FILES2TG will terminate with a DOS  errorlevel 1,
  507.      and display a brief message.  
  508.  
  509.      EXAMPLES:
  510.  
  511.      1] To import files using description case cleaning, mci code stripping,
  512.      a duplicate directory of "D:\BADFILE" and an uploader "SDS: TG", key the
  513.      following:     FILES2TG.EXE /K /R /M"D:\BADFILE\" /U"SDS:_TG"
  514.  
  515.      2] To import files, refreshing when needed and using a duplicate file
  516.      directory of "E:\FTGDUPE", along with high ascii stripping, key the
  517.      following:     FILES2TG.EXE -O -M"E:\FTGDUPE" -S
  518.  
  519.                        _______________________________
  520.                        // WHEN TO RUN FILES2TG.EXE? //
  521.  
  522.      You should run FILES2TG whenever your TIC file processor is executed
  523.      (if applicable).  Run FILES2TG as you see fit.
  524.  
  525.                         ______________________________
  526.                         // MULTINODE CONSIDERATIONS //
  527.  
  528.     Although file record locking and sharing routines are not implemented,
  529.     FILES2TG *can* be operated under some multinode environments.  Ensure
  530.     that two  copies of the programme never try to write to the same file
  531.     at the same time.  It is best to ensure that FILES2TG doesn't get run
  532.     twice at the same time.
  533.     
  534.     FILES2TG follows some  multinode conventions observed in Telegard 3.0
  535.     such as  keeping  files open for  brief  (brief!)  periods  of  time,
  536.     record tracking, and filemode checks.
  537.  
  538.     Timeslices are not awarded in FILES2TG (why  should they).
  539.  
  540.                         _____________________________
  541.                         //    ACTIVITY  LOGGING    //
  542.  
  543.     A unique feature of FILES2TG is the textual activity  logging system.
  544.     Previous  versions  featured  a crude logging system.  FILES2TG v1.10
  545.     now supports  a  more  detailed,  standardized textual logging system
  546.     that is still somewhat easy to understand.
  547.  
  548.     Much like the previous version, log entries are  created  in  blocks,
  549.     where each block of text represents when  FILES2TG  was  booted.  The
  550.     first part of the log block is the programme  initialization  record.
  551.     This block lists valuable information about  runtime  settings et al.
  552.     The initialization record (in the log) looks something like:
  553.  
  554.    "-----------  Friday, 04/05/1996,  FILES2TG.EXE v1.10.b1
  555.     +  01:51:41  Use cdrom bases...: No      Clean desc casing : No
  556.     +  01:51:41  Purge files.bb?...: No      Use FILE_ID.DIZ...: Yes
  557.     +  01:51:41  Keep any desc mci : Yes     Keep hi-ascii desc: Yes
  558.     +  01:51:41  Ignore extd  desc : No      Upload missing....: Yes
  559.     +  01:51:41  Refresh existing..: No      Memory swapping...: EMS 
  560.     +  01:51:41  SHARE.EXE detected: Yes     DESQview detected : No  (v0.00)
  561.     +  01:51:41  Uploader string...: FTG.EXE v1.10.b1
  562.     -----------  -----------------------------------------------------------"
  563.  
  564.     Following the programme initialization record, are step-by-step notes,
  565.     that is, brief messages about stages of execution.  These entries are
  566.     known as the "execution stage record", and can look something like:
  567.  
  568.    "-  01:51:46  Using archive FILE_ID.DIZ for description
  569.     %  01:51:46  Wrote entry: VP10B003.ZIP, 649623 bytes, 63 pts.,
  570.     ?  01:51:46  file does not exist: D:\TG\FILES\SYSOP\TGWAV101.ZIP
  571.     -  01:51:46  Making offline entry for: TGWAV101.ZIP
  572.     %  01:51:46  Wrote entry: TGWAV101.ZIP, 0 bytes, 0 pts.,"
  573.  
  574.     It is important to note the usage of symbols (characters).  The valid
  575.     logging symbol table is as follows:
  576.  
  577.     SYMBOL               MEANING
  578.     =================================================================
  579.     - (dash)             A trivial message.
  580.     + (plus)             Programme initialization record designator.
  581.     % (percent)          File import message.
  582.     ? (question mark)    Non-critical, Non-fatal error.
  583.     * (asterisk)         Duplicate file encountered.
  584.     $ (dollar sign)      Accounting/Transaction (ie moving, purging).
  585.     ~ (tilde)            Session information message.
  586.  
  587.     The textual logging  system  is  designed  to  provide the user  and
  588.     programmer with information about stages in execution.  Although  it
  589.     may be somewhat strange to look at, it is not without use.  As  time
  590.     passes, the logging will be enhanced.  At present 80% of  all  vital
  591.     modules / processes are logged.
  592.  
  593.                         _____________________________
  594.                        //  DUPLICATE FILE  MOVING  //
  595.  
  596.     When FILES2TG.EXE moves a file into the duplicate  directory (defined
  597.     by the -M"???" parameter, or  "FTGDUPE"  environmental  variable), it
  598.     maintains a  duplicate  file  tracking log, IF you enable the textual
  599.     logging system.
  600.  
  601.     The duplicate file tracking log is a standard DOS text file.  It is
  602.     written using the FILES.BBS format, with a few additions.  
  603.  
  604.     Just like textual activity logging,  this log file ("FTGDUPE.LOG") is
  605.     placed in your Telegard logs directory (ie: C:\BBS\LOGS).  This  file
  606.     is limited only by available hard drive space. 
  607.  
  608.                         ______________________________
  609.                         //    IMPORTING CD AREAS    //
  610.  
  611.     Perhaps the  most  common  usage of FILES2TG is importing file areas
  612.     contained on CD-ROM media.  Although  FILES2TG  will  not physically
  613.     create the areas based on cd-rom directories, it  can  toss files in
  614.     cd-rom FILES.BB? into Telegard.
  615.  
  616.     There are numerous ways of importing files  into  cd-rom areas.  The
  617.     most fail-safe way is by doing one area at a time.  For example, say
  618.     the area "C11_BBS" has been created, and points to read-only media
  619.     in drive G.  You're best bet would be:
  620.  
  621.           FILES2TG.EXE /B"C11_BBS" /C /X /P"V"
  622.  
  623.     Make sure  the  volume  label  for  the area matches the cd-rom disk
  624.     label.
  625.  
  626.     Times  may  exist  when FILES2TG cannot work with the FILES.BB? used
  627.     on a cd-rom.  This is 99.9% a result of the cd-rom publisher using a
  628.     non-standard FILES.BB? format.   To  overcome this problem, you will
  629.     need to copy the offending FILES.BB? to a hard drive  directory  and
  630.     edit it.  TWO OUT OF THREE offending FILES.BB? have  headers that do
  631.     not use semi-colon comment designators.
  632.  
  633.     Lets say you copy an offending FILES.BB? to C:\TEMP!.  After editing
  634.     it to compliance, you are ready to import the area.  Lets assume the
  635.     area  name is  "C11_OS2"  and we want to remove all  8-bit ascii and
  636.     import files as "free downloads".  One  possible command-line  would
  637.     be:
  638.  
  639.           FILES2TG.EXE /A"C:\TEMP!" /B"C11_OS2" /C /X /P"V;F"
  640.     
  641.  
  642.                       __________________________________
  643.                       // USING AN ALTERNATE FILES.BB? //
  644.  
  645.     By default, FILES2TG  will  read  from  any  FILES.BBS  (or FILES.BB1
  646.     ..FILES.BB9) located in the download path (file storage pathspec) for
  647.     each area.
  648.  
  649.     Because there are many cd-rom distributors who use what I  consider a
  650.     non-standard FILES.BB?, it  may  be  necessary  to read from a proper
  651.     files.bbs in order to achieve compatibility.
  652.  
  653.     One can copy the offending FILES.BB? into a  temporary area on a hard
  654.     drive, and modify it using any common textual editor.  
  655.  
  656.     The most common problems are headers in the files.bb? which  do *not*
  657.     start with the commonly-accepted semi-colon comment character.  There
  658.     are different  adaptations  of FILES.BB? standards for PCBoard, QBBS,
  659.     RBBS, and a few others.  I have even seen CDs' distributed  with non-
  660.     standard FILES.BB? filenames, such as "FILE.BBS", and "FILES.LST".
  661.  
  662.     I do realize that this  will  be  inconvenient for some, but who said
  663.     running a BBS was all fun and no work.
  664.  
  665.                         ______________________________
  666.                         //  DESCRIPTION  LINE WRAP  //
  667.  
  668.     Although a line-wrapping system  was  designed  for  this  version of
  669.     FILES2TG, it is not yet fully implemented.  Quite frankly, I think it
  670.     is more work  than necessary.  I   will  finish  a  simple  line-wrap
  671.     mechanism sooner or later, but I doubt I will go to all  the  trouble
  672.     Tim Strike went to when he wrote Telegard's description line wrapping
  673.     mechanism.
  674.  
  675.                         _____________________________
  676.                         //  FUTURE CONSIDERATIONS  //
  677.  
  678.    A number of features have been slated  for  implementation  within the
  679.    near future.  Some of the features include:
  680.  
  681.      i) file sharing/record locking routines
  682.      
  683.    No deadline has been set for the  implementation  of  these  features.
  684.  
  685.                         _____________________________
  686.                         //  FILES.BBS CONVENTIONS  //
  687.  
  688.    FILES2TG.EXE uses the common FILES.BBS textual control file.  Although
  689.    this version of FILES2TG allows for deviation  from  the  proper  file
  690.    format, it is still expected that certain conventions are followed.
  691.  
  692.    Failure of this format will result in erroneous data entries.
  693.  
  694.    DESCRIPTION LINE LENGTH:
  695.         Telegard supports description lines  of  up  to  45  characters.
  696.         FILES2TG will stop reading a description  line in the FILES.BBS
  697.         after it passes the 45 character limit.  This  applies  for DIZ
  698.         imports too.  MCI codes (`xx or |xx) count as 3 characters.
  699.  
  700.         The 45 character  limit  is in  accordance  with  the  accepted
  701.         FILE_ID.DIZ standards.  
  702.  
  703.  
  704.    EXTENDED DESCRIPTION CHARACTERS:
  705.         FILES2TG supports the popular extended description characters.
  706.         IF the extended description character used in the FILES.BBS is
  707.         not a member of [|, +, :, >, +, ' '], then the  program  will
  708.         probably not function properly.
  709.  
  710.         Please note the following example:
  711.                 FILE.ZIP  This is a file with a two line xtended
  712.                           |description using a valid xtended desc
  713.                           |character [|, +, :, >, ' ']
  714.                 FILE.ZIP  This is a file with a two line xtended
  715.                           description not using a valid xtended desc
  716.                           description character, but spaces instead
  717.  
  718.         The  above  two  FILES.BB? record entries are acceptable  and 
  719.         will be parsed without error, however the   following  record
  720.         is *not* valid and will result in a parse error:
  721.  
  722.                 FILE.ZIP  This is a file with a two line xtended
  723.                 description not using a valid xtended desc char
  724.                 or spaces instead.  This will cause parse problems.
  725.  
  726.  
  727.    EXTENDED DESCRIPTION LENGTH:
  728.         New coding has enabled FILES2TG to accept up to 50  lines  of
  729.         extended description (10 linked list nodes).   Anything  more
  730.         than 50 lines is simply ignored.
  731.  
  732.         Although  FILES2TG  will  import  50   lines  of description,
  733.         Telegard will only read the first 26  lines  of  description.
  734.         There should  be no real reason to describe a file using more
  735.         than 26  lines  of  extended description, however, the option
  736.         for some people is necessary.
  737.  
  738.    BLANK LINES:
  739.         If the first few lines of the FILES.BB? are  blank,  FILES2TG
  740.         will  continue reading until it  can locate a valid FILES.BB?
  741.         record.  If one cannot be found, FILES2TG will simply exit.
  742.  
  743.         Blank lines between FILES.BB? records are now accepted.  If a
  744.         a blank line is encountered between FILES.BB? records, it  is
  745.         simply ignored.
  746.  
  747.    HEADERS/FOOTERS:
  748.         Although headers and footers should not appear in any  proper
  749.         FILES.BB? file, this version of FILES2TG  will  permit  their
  750.         presence and simply ignore them provided *all* comment blocks
  751.         are designated with a semi-colon on the left most row & col.
  752.  
  753.  
  754.    FILES2TG was tested with the FILES.BBS found on the NightOwl v20 cdrom
  755.    and worked without flaw.  FILES2TG was also tested using the FILES.BBS
  756.    created by Allfix[r] 4.32e.
  757.  
  758.                         _____________________________
  759.                         // CREDIT WHERE IT BELONGS //
  760.              
  761.     As with most  projects, it always helps to have support. I would like
  762.     to thank  all the members  of The Telegard Team for beta testing this
  763.     project.  Special thanks to Deanna Luke, Don Johnson & Mike Smith.
  764.  
  765.     FILES2TG was first  written  by Martin  J.  Pollard  as a part of the
  766.     Telegard 2.7 utilities package.  FILES2TG.EXE  v1.00  was  taken from
  767.     Michael Bogden's IEBBS.EXE source code. FILES2TG.EXE v1.10 is totally
  768.     rewritten, from scratch using *no* previous coding.
  769.  
  770.     "This product uses the SPAWNO routines by Ralf Brown to minimize memory
  771.     use while shelling to DOS and running other programs." (v4.10, 4/26/91)
  772.  
  773.     "This product uses Tim Strike's FAST file index search coding."  Many
  774.     thanks to Tim for his willingness to share.
  775.  
  776.     All  other  products mentioned are copyright and or trademark of their
  777.     respective manufactures.
  778.  
  779.                         _____________________________
  780.                         // PROGRAMME  REGISTRATION //
  781.  
  782.     This programme is *NOT*  freeware,  however  a  registration is *NOT*
  783.     required.  Even though the  programme is   very   flexible,  It  does
  784.     not warrant registration burdens.  Use it as you please.
  785.  
  786.                         _____________________________
  787.                         // CONTACTING  THE  AUTHOR //
  788.  
  789.     If you have any problems or  suggestions,  you can contact the author
  790.     via the following means:
  791.  
  792.              NETMAIL:     Please address all netmail to "Dave Turner":
  793.                           Fidonet        -: 1:250/134
  794.                           Telenet Canada -: 20:23/503
  795.                           THNet          -: 901:910/0
  796.  
  797.       INTERNET EMAIL:     ae907@torfree.net
  798.  
  799.       BULLETIN BOARD:     THN Systems Canada
  800.                           (416) 255-2484
  801.                           2400-14400 v.42bis
  802.                           23hrs / 7 days a week
  803.                           Zone Mail hour is 4:00am to 5:30am EST
  804.  
  805.         POSTAL MAIL:      THN Systems Canada
  806.                           174 Sixth Street
  807.                           Etobicoke, Ontario, Canada
  808.                           M8V 3A5
  809.  
  810.         We invite all comments and suggestions of a positive nature.  
  811.  
  812.                        THANK YOU FOR CHOOSING FILES2TG
  813.                                        
  814.